Schema bimoR.v1
Schema bimoR.v1 : Typ złożony GetChunkResponse
Typ złożony GetChunkResponse
Opis
Rezultat przetworzenia zamówienia raportu
Typ elementu wyjściowego dla metody getReportRequest w BIG API, zawiera listę możliwych rezultatów operacji zamówienia raportu.
Przestrzeń nazw http://api.big.pl/bimoR/v1
Typ podstawowy
Extension of Typ złożony ResponseAbstract
Diagram
Element success Element requestError Element authorisationError Choice Typ złożony GetChunkResponse
Przegląd
GetChunkResponse Extension of Typ złożony ResponseAbstract
Rezultat przetworzenia zamówienia raportu
Typ elementu wyjściowego dla metody getReportRequest w BIG API, zawiera listę możliwych rezultatów operacji zamówienia raportu.
Choice
authorisationError Typ złożony AuthorisationError
Błąd autoryzacji
Sequence
errorType Typ prosty authErrorTypeEnum
Typ błędu autoryzacji
Typ błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.
errorDescription Typ prosty string
Opis typu błędu autoryzacji
Opis typu błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.
requestError Typ złożony RequestError
Błąd walidacji zapytania
Sequence
currentRequest optional Typ złożony RequestAbstract
Bieżące zapytanie
operationType optional Typ prosty getOperationTypeEnum
Rodzaj operacji
Kod określający rodzaj wywołanej operacji, dla której system przeprowadził walidację zapytania
validationError 1..∞ Typ złożony ValidationError
Błąd walidacji
Kolekcja wykrytych przez system błędów walidacji
Sequence
orderNumber Typ prosty int6
Numer kolejny błędu
Numer kolejny błędu walidacji wykrytego w komunikacie. Numeracja zaczyna się od „1”.
validationRuleId Typ prosty string32
Kod błędu
Kod błędu walidacji
message optional Typ prosty string
Opis błędu
Opis błędu walidacji
faultyElementPath optional Typ prosty string
XPath
XPath do błędnej ścieżki komunikatu
dependentElementPath optional Typ prosty string
Xpath do pola zależnego
Xpath do pola zależnego, względem pola, do którego zgłoszony został błąd (@ValidationError.faultyElementPath)
success Typ złożony UnifiedReportChunk
Pozytywny rezultat przetworzenia zapytania o kawałek raportu zbiorczego.
status optional Typ prosty unifiedReportBigStatusEnum
Status raportu z danego BIG w ramach raportu zbiorczego
Status raportu z danego BIG w ramach raportu zbiorczego.
unifiedReportId optional Typ prosty unifiedReportId
Identyfikator raportu zbiorczego BIG
Identyfikator raportu zbiorczego BIG zamówionego wcześniej przez usługę getReport.
chunkNumber optional xs:int
Numer kolejny kawałka raportu. Jeżeli raport składa się tylko z jednego kawałka atrybut można pominąć
chunkCount optional xs:int
Ilość kawałków składających się na cały raport. Jeżeli raport składa się tylko z jednego kawałka atrybut można pominąć
Sequence
Number Typ prosty string150
Unikatowy numer raportu BIG'a generującego raport.
Date xs:dateTime
Data i czas wygenerowania raportu
NegativeObligationInformations optional Typ złożony NegativeObligationInformationsType
Kolekcja zawierająca informacje o niespłaconych zobowiązaniach
count required xs:int
Całkowita ilość elementów w kolekcji
Sequence
NegativeObligationInformation 1..∞ Typ złożony NegativeObligationInformationType
Informacja o niespłaconych zobowiązaniach
PositiveObligationInformations optional Typ złożony PositiveObligationInformationsType
Kolekcja zawierająca informacje o spłaconych zobowiązaniach
count required xs:int
Całkowita ilość elementów w kolekcji
Sequence
PositiveObligationInformation 1..∞ Typ złożony PositiveObligationInformationType
Kolekcja informacji o spłaconych zobowiązaniach
provider Typ złożony Provider
Identyfikator raportu z danego BIG
Sequence
code Typ prosty providerCode
Kod dostawcy danych (BIG)
Kod dostawcy danych (BIG)
name Typ prosty string250
Nazwa dostawcy danych (BIG)
Nazwa dostawcy danych (BIG)
Używany przez
Element getChunkResponse
Źródło
<xs:complexType name="GetChunkResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Rezultat przetworzenia zamówienia raportu</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ elementu wyjściowego dla metody getReportRequest w BIG API, zawiera listę możliwych rezultatów operacji zamówienia raportu.</div>
    </xs:documentation>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="bc:ResponseAbstract">
      <xs:choice>
        <xs:element name="authorisationError" type="bc:AuthorisationError">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd autoryzacji</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="requestError" type="br:RequestError">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd walidacji zapytania</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="success" type="br:UnifiedReportChunk">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Pozytywny rezultat przetworzenia zapytania o kawałek raportu zbiorczego.</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>
Zobacz także
Schema bimoR.v1